//  ================================================================
//  Copyright (c) 2000-2005 CollabNet.  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//  
//  1. Redistributions of source code must retain the above copyright
//  notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//  notice, this list of conditions and the following disclaimer in the
//  documentation and/or other materials provided with the distribution.
//  
//  3. The end-user documentation included with the redistribution, if
//  any, must include the following acknowlegement: "This product includes
//  software developed by Collab.Net <http://www.Collab.Net/>."
//  Alternately, this acknowlegement may appear in the software itself, if
//  and wherever such third-party acknowlegements normally appear.
//  
//  4. The hosted project names must not be used to endorse or promote
//  products derived from this software without prior written
//  permission. For written permission, please contact info@collab.net.
//  
//  5. Products derived from this software may not use the "Tigris" or 
//  "Scarab" names nor may "Tigris" or "Scarab" appear in their names without 
//  prior written permission of Collab.Net.
//  
//  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
//  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
//  IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
//  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
//  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
//  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
//  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
//  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
//  ====================================================================
//  
//  This software consists of voluntary contributions made by many
//  individuals on behalf of Collab.Net.


package org.tigris.scarab.om;

import org.apache.torque.Torque;
import org.apache.torque.TorqueException;
import org.apache.torque.om.ObjectKey;
import org.apache.torque.om.Persistent;
import org.tigris.scarab.notification.ActivityType;
import org.tigris.scarab.notification.NotificationManagerFactory;
import org.tigris.scarab.tools.localization.L10NKeySet;
import org.tigris.scarab.util.ScarabException;
import org.tigris.scarab.util.build.l10nchecker.L10nKey;

/**
 * This class manages NotificationFilter objects.
 * The skeleton for this class was autogenerated by Torque  * You should add additional methods to this class to meet the
 * application requirements.  This class will only be generated as
 * long as it does not already exist in the output directory.
 */
public class NotificationFilterManager
    extends BaseNotificationFilterManager
{
    /**
     * Creates a new <code>NotificationFilterManager</code> instance.
     *
     * @exception TorqueException if an error occurs
     */
    public NotificationFilterManager()
        throws TorqueException
    {
        super();
    }
    
    public static NotificationFilter getNotificationFilter(NotificationStatus notif) throws ScarabException
    {
        NotificationFilter filter = null;
        try
        {
            Long issueId = notif.getIssueId();
            Issue issue = IssueManager.getInstance(issueId);
            Integer moduleId = issue.getModuleId();
            Integer userId = notif.getReceiverId();
            ActivityType activityType = notif.getActivityType();
            filter = getNotificationFilter(moduleId, userId, activityType.getCode());
        }
        catch(TorqueException te)
        {
            throw new ScarabException(L10NKeySet.ExceptionTorqueGeneric, te);
        }
        return filter;
    }
    
    public static NotificationFilter getNotificationFilter(Integer moduleId, Integer userId, String activityType) throws ScarabException
    {
        NotificationFilter filter = null;
        
        try
        {
            filter = NotificationFilter.createDefaultFilter( 
                        moduleId, 
                        userId,
                        NotificationManagerFactory.getInstance().getManagerId(),
                        ActivityType.getActivityType(activityType));
        }
        catch(TorqueException te)
        {
            throw new ScarabException(L10NKeySet.ExceptionTorqueGeneric,te);
        }

        ObjectKey pk = filter.getPrimaryKey();
        NotificationFilter result;
        try
        {
            result = NotificationFilterManager.getInstance(pk);
            if(result == null)
            {
                result = filter;
            }
        }
        catch(Exception e)
        {
            result = filter;
        }
        
        return result;
    }

    /**
     * determines whether user has enabled notifications for given activityType
     * in given module.
     * @param user
     * @param act
     * @return
     * @throws ScarabException 
     */
    public static boolean isNotificationEnabledFor(Integer moduleId, Integer userId, boolean isSelf, String activityType) throws ScarabException
    {
        NotificationFilter filter = getNotificationFilter(moduleId, userId, activityType);
        boolean result;
        if(isSelf)
        {
            result = filter.getSendSelf();
        }
        else
        {
            result = filter.getFilterState();
        }
        return result;
    }

    
}
